home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / Object.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  7KB  |  249 lines
  1. //
  2. // (c) 1999 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // Object.h
  5. //
  6. // API for the package 'Object'.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /flux/packages/Object.h 9     27/11/00 21:45 Will $
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #ifdef FLUX_COMPILE
  16.  
  17. FLUX_DECLARE_EXTENSION(Object);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "Object" )
  22. #endif // _MSC_VER >= 1000
  23. #endif // FLUX_LIB
  24. #else
  25.  
  26. // Accessors for object properties ////////////////////////////////////////////
  27.  
  28. //
  29. // float Object.FloatProperty( hobject o, string property )
  30. //
  31. // Retrieve the float property value for the object
  32. //
  33. prototype float Object.FloatProperty( hobject o, string property );
  34.  
  35. //
  36. // int Object.IntProperty( hobject o, string property )
  37. //
  38. // Retrieve the integer property value for the object
  39. //
  40. prototype int Object.IntProperty( hobject o, string property );
  41.  
  42. //
  43. // int Object.BoolProperty( hobject o, string property )
  44. //
  45. // Retrieve the bool property value for the object
  46. //
  47. prototype bool Object.BoolProperty( hobject o, string property );
  48.  
  49. //
  50. // int Object.IDModulus( hobject o, int modulus );
  51. // 
  52. // Return the modulus of the object's id with the int supplied.
  53. //
  54. prototype int Object.IDModulus( hobject o, int modulus );
  55.  
  56.  
  57. //
  58. // hobject Object.HandleProperty( hobject o, string property )
  59. //
  60. // Retrieve the handle property value for the object
  61. //
  62. prototype hobject Object.HandleProperty( hobject o, string property );
  63.  
  64. //
  65. // string Object.StringProperty( hobject o, string property )
  66. //
  67. // Retrieve the string property value for the object
  68. //
  69. prototype string Object.StringProperty( hobject o, string property );
  70.  
  71. //
  72. // list Object.ListProperty( hobject o, string property )
  73. //
  74. // Retrieve the object property value for the object
  75. prototype list Object.ListProperty( hobject o, string property );
  76.  
  77.  
  78. //
  79. // float Object.VectorPropertyX( hobject o, string property )
  80. //
  81. // Retrieve the x coordinate of the vector property value for the object
  82. //
  83. prototype float Object.VectorPropertyX( hobject o, string property );
  84.  
  85. //
  86. // float Object.VectorPropertyY( hobject o, string property )
  87. //
  88. // Retrieve the y coordinate of the vector property value for the object
  89. //
  90. prototype float Object.VectorPropertyY( hobject o, string property );
  91.  
  92. //
  93. // float Object.VectorPropertyZ( hobject o, string property )
  94. //
  95. // Retrieve the z coordinate of the vector property value for the object
  96. //
  97. prototype float Object.VectorPropertyZ( hobject o, string property );
  98.  
  99. // Settor for object properties ///////////////////////////////////////////////
  100.  
  101. //
  102. // Object.SetFloatProperty( hobject o, string property, float value )
  103. //
  104. // Set the float property value for the object
  105. //
  106. prototype Object.SetFloatProperty( hobject o, string property,
  107.                                    float value );
  108.  
  109. //
  110. // Object.SetIntProperty( hobject o, string property, int value )
  111. //
  112. // Set the int property value for the object
  113. //
  114. prototype Object.SetIntProperty( hobject o, string property,
  115.                                  int value );
  116.  
  117. //
  118. // Object.SetBoolProperty( hobject o, string property, bool value )
  119. //
  120. // Set the Bool property value for the object
  121. //
  122. prototype Object.SetBoolProperty( hobject o, string property,
  123.                                   bool value );
  124.  
  125. //
  126. // Object.SetHandleProperty( hobject o, string property, handle value )
  127. //
  128. // Set the handle property value for the object
  129. //
  130. prototype Object.SetHandleProperty( hobject o, string property,
  131.                                     hobject value );
  132.  
  133. //
  134. // Object.SetStringProperty( hobject o, string property, string value )
  135. //
  136. // Set the string property value for the object
  137. //
  138. prototype Object.SetStringProperty( hobject o, string property,
  139.                                     string value );
  140.  
  141. //
  142. // Object.SetListProperty( hobject o, string property, list value )
  143. //
  144. // Set the list property value for the object
  145. //
  146. prototype Object.SetListProperty( hobject o, string property, list value );
  147.  
  148.  
  149. //
  150. // Object.SetVectorProperty( hobject o, 
  151. //                             string property, 
  152. //                             float x, float y, float z )
  153. //
  154. // Set a vector property value for the object
  155. //
  156. prototype Object.SetVectorProperty( hobject o, 
  157.                                     string property,
  158.                                     float x,
  159.                                     float y,
  160.                                     float z );
  161.  
  162. // Query existence ////////////////////////////////////////////////////////////
  163.  
  164. //
  165. // bool Object.PropertyExists( hobject o, string property )
  166. //
  167. // Does the object implement this property?
  168. //
  169. prototype bool Object.PropertyExists( hobject o, string property );
  170.  
  171. // Add user properties /////////////////////////////////////////////////////
  172.  
  173. //
  174. // bool Object.AddFloatProperty( hobject o, string property, float value )
  175. //
  176. // Attach float property to the sim, if it does not overwrite inbuilt
  177. // properties
  178. //
  179. prototype bool Object.AddFloatProperty( hobject o, string property,
  180.                                         float value );
  181.  
  182. //
  183. // bool Object.AddIntProperty( hobject o, string property, int value )
  184. //
  185. // Attach int property to the sim, if it does not overwrite inbuilt
  186. // properties
  187. //
  188. prototype bool Object.AddIntProperty( hobject o, string property,
  189.                                       int value );
  190.  
  191. //
  192. // Object.AddBoolProperty( hobject o, string property, bool value )
  193. //
  194. // Add the Bool property value to the object
  195. //
  196. prototype Object.AddBoolProperty( hobject o, string property,
  197.                                   bool value );
  198.  
  199. //
  200. // bool Object.AddHandleProperty( hobject o, string property, hobject value )
  201. //
  202. // Attach handle property to the sim, if it does not overwrite inbuilt
  203. // properties
  204. //
  205. prototype bool Object.AddHandleProperty( hobject o, string property,
  206.                                          hobject value );
  207.  
  208. //
  209. // bool Object.AddStringProperty( hobject o, string property, string value )
  210. //
  211. // Attach string property to the sim, if it does not overwrite inbuilt
  212. // properties
  213. //
  214. prototype bool Object.AddStringProperty( hobject o, string property,
  215.                                          string value );
  216.  
  217. //
  218. // bool Object.AddListProperty( hobject o, string property, list value )
  219. //
  220. // Attach list property to the sim
  221. //
  222. prototype bool Object.AddListProperty( hobject o, string property, list value );
  223.  
  224. //
  225. // Object.AddVectorProperty( hobject o, 
  226. //                             string property, 
  227. //                             float x, float y, float z )
  228. //
  229. // Attach vector property to the sim, if it does not overwrite inbuilt
  230. // properties
  231. //
  232. prototype Object.AddVectorProperty( hobject o, 
  233.                                     string property,
  234.                                     float x,
  235.                                     float y,
  236.                                     float z );
  237.  
  238. // Remove user properties /////////////////////////////////////////////////////
  239.  
  240. //
  241. // Object.RemoveProperty( hobject o, string property )
  242. //
  243. // Remove user property from object. Inbuilt properties cannot be removed
  244. // using this method
  245. //
  246. prototype Object.RemoveProperty( hobject o, string property );
  247.  
  248. #endif // FLUX_LIB
  249.